API Documentation
BufferView.h
1 // BufferView.h
3 //
5 
6 namespace nkMemory
7 {
16  template <typename T = unsigned char>
17  class BufferView
18  {
19  public :
20 
21  // Constructors, destructor
33  BufferView (T* data, unsigned long long size) ;
40  BufferView (const Buffer& buffer) ;
49  BufferView (const Buffer& buffer, unsigned long long index, unsigned long long length)
54  ~BufferView () = default ;
55 
56  public :
57 
58  // Getters
62  T* getData () const ;
66  unsigned long long getSize () const ;
70  bool empty () const ;
74  T& front () ;
78  T& back () ;
79 
80  public :
81 
82  // Operators
89  T& operator[] (unsigned long long index) ;
96  const T& operator[] (unsigned long long index) const ;
97 
98  public :
99 
100  // Constructors templated
106  template <typename U>
107  BufferView (BufferCast<U>& bufferCast) ;
113  BufferView (BufferCast<T>& bufferCast) ;
119  BufferView (std::vector<T>& vec) ;
120  } ;
121 }
nkMemory::BufferView::BufferView
BufferView(const Buffer &buffer)
nkMemory::BufferView::BufferView
BufferView(BufferCast< U > &bufferCast)
nkMemory::BufferView
A view over data.
Definition: BufferView.h:18
nkMemory::BufferView::getData
T * getData() const
nkMemory::BufferView::back
T & back()
nkMemory::BufferView::getSize
unsigned long long getSize() const
nkMemory::Buffer
A buffer holding binary data.
Definition: Buffer.h:32
nkMemory::BufferView::BufferView
BufferView(T *data, unsigned long long size)
nkMemory::BufferView::operator[]
T & operator[](unsigned long long index)
nkMemory::BufferCast
Holds a Buffer and make it easy to cast the binary data.
Definition: BufferCast.h:18
nkMemory::BufferView::BufferView
BufferView()
nkMemory::BufferView::empty
bool empty() const
nkMemory::BufferView::front
T & front()
nkMemory::BufferView::BufferView
BufferView(const Buffer &buffer, unsigned long long index, unsigned long long length) ~BufferView()=default
nkMemory::BufferView::BufferView
BufferView(BufferCast< T > &bufferCast)
nkMemory::BufferView::BufferView
BufferView(std::vector< T > &vec)
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7